CreateDataHoldV1

A POST request that creates and immediately enables a data hold request for a content author for a specified set of platforms. The endpoint is https://api.aware.work/external/dataholds/v1.

Access

To access this operation, your API token must have one of the following permissions:

• Data Holds Full Access

For more information, see the API token documentation.

Request Format

Parameters

Note:

• You can retrieve a list of your available platforms using the ListPlatformsV1 API. All Data Hold permissions include the permission to list platforms.

Parameter	Required	Description	Type	Format / Options
holdKeyType	Yes	The type of hold that should be created - this will impact the holdKey value	string	Email / AADGroup
holdKey	Yes	The key that the hold matches against; email address in the case of holdKeyType of Email; AAD Group name in the case of holdKeyType of AADGroup	string
name	Yes	A name to reference the data hold by	string
platforms	Yes	Platform IDs for which the hold should be enforced	list[string]	strings must be in uuid4 format and correspond to an existing platform

Query

curl -X POST --location "https://api.aware.work/external/dataholds/v1" \
    -H "Content-Type: application/json" \
    -H "X-Aware-Api-Key: ${API_TOKEN}" \
    -d "{
          \"holdKeyType\": \"Email\",
          \"holdKey\": \"user@example.com\",
          \"name\": \"My hold for User\",
          \"platforms\": [
            \"793e6cbf-7dd0-786e-9ab8-cc91108e3066\"
          ]
        }"

Response Format

If the request is successful, the API will return a 200 response and a JSON description of the new Data Hold:

{
  "holdRequestModelId": "5e1177db-39c2-ed17-1195-b2e50c242cd0",
  "holdKeyType": "Email",
  "holdKey": "user@example.com",
  "name": "My hold for User",
  "startedOn": "2023-07-07T01:02:03.0004",
  "stoppedOn": null,
  "platforms": [
    "b8479d5f-4fe6-e2ec-3f10-dfc270f88816"
  ]
}